Release 10.1A: OpenEdge Development:
Java Open Clients

Methods

The ProDataObjectMetaData class provides the following methods.

setFieldMetaData( )

Adds the specified field (column property) to the property list of the specified ProDataObject type:

Syntax

void setFieldMetaData(int fieldNumber, String fieldName, int extent,                       int proType, int userOrder, int xmlMapping)

fieldNumber

Specifies a 1-based position for this column property that corresponds to the position of a mapped field in a Progress 4GL temp-table.

fieldName

Specifies a name for the column property that is typically identical to a mapped field in the corresponding 4GL temp-table. The value cannot be null and must be unique among column properties in the specified ProDataObject type.

extent

Specifies if and how the column property represents an array field in the corresponding temp-table. The value must be 0 or greater. If the value is greater than 1, this column property is many-valued (represents an array field) and the value is its extent. If the property represents a BLOB or CLOB field, the value must be 0 or 1.

proType

Specifies the value of a class constant defined in the com.progress.open4gl.Parameter class. The specified class constant indicates the 4GL data type of the mapped temp-table field. For more information on these class constants, see the information on specifying data type meta data for temp-tables in Chapter 4, " Passing Parameters." To identify the Java data type that the column property assumes for the specified 4GL data type, see Table 5–3.

userOrder

Specifies a 0-based user order position for the column property.

xmlMapping

Reserved for future use. Always specify 0.

For more information on column properties, see the "Using Java SDO classes to access Property meta data" section.

getTableName( )

Returns the table name associated with this ProDataObjectMetaData object:

Syntax

String getTableName()

getBImageFlag( )

Returns the bimageFlag value defined for this ProDataObjectMetaData object (corresponding to the BEFORE-TABLE attribute of the corresponding Progress 4GL temp-table):

Syntax

boolean getBImageFlag()

getUserOrder( )

Returns the user order position of the specified column property:

Syntax

int getUserOrder(int propertyIndex)

propertyIndex

Specifies a 0-based index into the ProDataObject property list, limited by the value of the getFieldCount( ) method. It returns a value that corresponds to the relative position specified by fieldNumber in the setFieldMetaData( ) method.

getProType( )

Returns the Progress 4GL data type of the specified column property as a class constant value found in com.progress.open4gl.Parameter:

Syntax

int getProType(int propertyIndex)

propertyIndex

Specifies a 0-based index into the ProDataObject property list, limited by the value of the getFieldCount( ) method. It returns a value that corresponds to the relative position specified by fieldNumber in the setFieldMetaData( ) method.

For more information on the class constant values provided by the com.progress.open4gl.Parameter class, see the information on specifying data type meta data for temp-tables in Chapter 4, " Passing Parameters."

getExtent( )

Returns the extent value of the specified column property:

Syntax

int getExtent(int propertyIndex)

propertyIndex

Specifies a 0-based index into the ProDataObject property list, limited by the value of the getFieldCount( ) method. It returns a value that corresponds to the relative position specified by fieldNumber in the setFieldMetaData( ) method.

If the column property does not represent an array field, the method always returns 0.

getFieldName( )

Returns the name of the specified column property:

Syntax

int getFieldName(int propertyIndex)

propertyIndex

Specifies a 0-based index into the ProDataObject property list, limited by the value of the getFieldCount( ) method. It returns a value that corresponds to the relative position specified by fieldNumber in the setFieldMetaData( ) method.

getFieldCount( )

Returns the number of column properties defined for the specified ProDataObject type:

Syntax

int getFieldCount()

The value is identical to the setting of numFields in the constructor that instantiates this ProDataObjectMetaData.

setNoSchemaMarshal( )

Indicates, as a run-time only setting, whether schema information for the specified ProDataObject collection is sent to the AppServer along with the data:

Syntax

void setNoSchemaMarshal(boolean flag)

flag

When set to true, any application service method that passes a ProDataGraph parameter containing this ProDataObjectMetaData marshals only the data to the AppServer from the specified ProDataObject collection. This setting suppresses transmission of index descriptions and all field information, which helps to speed the transmission of data. You can change this setting at any point where you invoke application service methods.

getNoSchemaMarshal( )

Returns true if the most recent invocation of the setNoSchemaMarshal( ) method indicated that the specified ProDataObject collection is to be marshalled to the AppServer without schema information:

Syntax

boolean getNoSchemaMarshal()